home *** CD-ROM | disk | FTP | other *** search
/ Aminet 12 / Aminet 12 (1996)(GTI - Schatztruhe)[!][Jun 1996].iso / Aminet / dev / lang / HeliOS4.lha / helios_demo_disk4 / docs / userinterface / InterpreterControls.doc < prev    next >
Encoding:
Text File  |  1995-03-20  |  11.6 KB  |  380 lines
  1. ***************************
  2. Interpreter Control Buttons
  3. ***************************
  4.  
  5. At the top of the interpret window are a number of buttons.
  6.  
  7. These look fairly self-explanatory at first sight, but there are a few
  8. subtleties and non-obvious features which need to be explained.
  9.  
  10.  
  11. *************************
  12. The editor select buttons
  13. *************************
  14.  
  15. The four buttons which allow entry to the editors (3 Editors + "OUT" editor)
  16. have several modes of action:
  17.  
  18.  
  19. Single left mouse click  -  Enters the editor associated with that button
  20.                             and highlights the button.
  21.  
  22. Double left mouse click  -  When inside an editor, enters and leaves the
  23.                             "split screen" mode which allows you to view
  24.                             two editors on screen together.
  25.  
  26. Single left mouse click  -  Compiles that editor using current compile mode
  27. while holding down the      whether you are in interpret or edit mode.
  28. right mouse button, the
  29. <Ctrl> key, or the <Shift>
  30. key.
  31.  
  32.  
  33. *******************************************************************
  34. Square button to left of editor buttons - the "Split screen" button
  35. *******************************************************************
  36.  
  37. When you are in the interpreter, this button will take you back into "edit"
  38. mode into the same configuration which you last set up within "edit" mode.
  39. It acts as an instant return to your editor setup.
  40.  
  41. This button acts as a "split screen" toggle when you are actually within
  42. an editor.
  43.  
  44. The imagery on this button indicates whether the current mode is "split"
  45. or "single".
  46.  
  47.  
  48. *******************
  49. The "Colour" button
  50. *******************
  51.  
  52. This simply brings up the colour requester.
  53.  
  54.  
  55. ******************
  56. The "Redo" button
  57. ******************
  58.  
  59. This rebuilds the HeliOS screen display and is only used in the interpreter.
  60.  
  61.  
  62. *****************
  63. The "Help" button
  64. *****************
  65.  
  66. 1. Pressed alone.
  67.  
  68. Switches to "Help" mode, where accessing any menu or button will bring
  69. up a short explanatory text.
  70.  
  71. 2. Pressed with the <Ctrl> key.
  72.  
  73. Tries to display help, if available, on the word under the cursor.
  74.  
  75. See notes on the user editable Vocabulary Help file.
  76.  
  77.  
  78. *****************
  79. The "DBug" button
  80. *****************
  81.  
  82. This changes the stack display bar into a set of debugger control buttons
  83. and simultaneously enters debug mode.  You will then be in debug mode until
  84. you press the "DBug" button again, which reverts to normal interpretation.
  85.  
  86.  
  87. Debug buttons:
  88.  
  89. *************
  90. Screen Output
  91. *************
  92.                - These buttons toggle debugger output streams
  93. *************
  94. Buffer Output
  95. *************
  96.  
  97. The idea here is that when in debug mode, your program's normal screen
  98. output will be stopped, and the screen will be used by the debugger to
  99. print debug messages.  Similarly the "Out" buffer will get debug output.
  100.  
  101. If you switch off either of the Screen/Buffer output buttons, the normal
  102. program output will be sent to that output stream rather than the debug
  103. output.  Thus you can choose which output you want to see, and can view
  104. one output while sending the other to the "Out" buffer.
  105.  
  106. These buttons can be pressed as your program is executing so that you can
  107. alternate between output modes at will during a debugging session.  This
  108. gives great flexibility to the system.
  109.  
  110. **********************************************
  111. The "Step" button and associated string gadget
  112. **********************************************
  113.  
  114. The step string gadget lets you set how many times the debugger will "skip"
  115. between calls to the debug routines.  A setting of "1" will cause the debug
  116. code to be run for every threaded word, a setting of "4" will sample every
  117. fourth threading etc.
  118.  
  119. Again this can be altered at will as the program executes, and can also be
  120. changed by the debug software.  Thus you could insert debug routines which
  121. step through certain sections of code in large jumps until a "vital" part
  122. of the program is reached, whereupon the debugger could be made under the
  123. control of software to "automatically" change to single stepping.
  124.  
  125. The "Step" button, if switched "On", will cause the software to pause at
  126. each debug entry point rather than free running.  Thus you can skip parts
  127. of a program and return to debug "paused" mode by entering a certain value
  128. into the string gadget, setting "Step" to "On", then pressing "Run".
  129.  
  130. Again this can be done interactively while the program is executing or
  131. from within the software under debug program control.
  132.  
  133. ****************
  134. The "Run" button
  135. ****************
  136.  
  137. This starts the program executing after you have paused within debug mode.
  138.  
  139. This function is also available from program control.
  140.  
  141. ******************
  142. The "Pause" button
  143. ******************
  144.  
  145. This stops the program executing and pauses within debug mode.
  146.  
  147. This function is also available from program control.
  148.  
  149.  
  150. ******************
  151. The "Abort" button
  152. ******************
  153.  
  154. This aborts the debug session and quits the program.
  155.  
  156. This function is also available from program control.
  157.  
  158.  
  159. **********************************************
  160. The "Dump" button and associated string gadget
  161. **********************************************
  162.  
  163. This button lets you set up an address for a memory dump which can be
  164. carried out by pressing the "Dump" button at any time while the program
  165. is executing.
  166.  
  167. This function is also available from program control.
  168.  
  169. *****************
  170. Interpreter Menus
  171. *****************
  172.  
  173. ******
  174. HeliOS
  175. ******
  176.  
  177.  
  178. HELP ON USER INTERFACE - Brings up mini-help texts on all buttons and menus
  179.  
  180. HELP ON VOCABULARY     - Brings up mini-help text on word under cursor
  181.  
  182. ABOUT             -  Program information
  183.  
  184.  
  185. CORE VOCABULARY   -  Lists only the CORE dictionary in a columnar layout
  186.  
  187.  
  188. USER VOCABULARY   -  Lists only the USER dictionary (words you have created)
  189.  
  190.                      This lists your words in order of creation.
  191.  
  192. FULL VOCABULARY   -  Lists the CORE dictionary followed by USER words
  193.  
  194.  
  195. Note: All three above functions list to screen but do not go through the
  196.       interpreter output stream. This means that they avoid interaction
  197.       with the DEBUG functions and do not write to the "Out" buffer.
  198.  
  199.       The traditional Forth interpreter word VLIST lists the full
  200.       vocabulary, with CORE words followed by USER words in order of
  201.       creation.  This is equivalent to the FULL VOCABULARY menu option
  202.       apart from the  difference in output streaming as mentioned above.
  203.  
  204.       HeliOS has two other CORE words, CVLIST and UVLIST to list CORE and
  205.       USER vocabularies, which are equivalent to the menu functions.
  206.  
  207.       Using the words VLIST, CVLIST and UVLIST from the interpreter will
  208.       send output to the "Out" buffer etc, so you may find occasions where
  209.       this method is more useful than the menu option.
  210.  
  211.  
  212. LOAD ENVIRONMENT    -  Load a user-environment-config file
  213.  
  214. SAVE ENVIRONMENT    -  Saves all user configuration settings as default
  215.  
  216. SAVE ENVIRONMENT AS -  Saves all user configuration settings to a file
  217.  
  218.  
  219. Note: We wanted to avoid massive configuration requesters and complex user
  220.       editable config files if possible, since beginners find such things
  221.       overwhelming.
  222.  
  223.       Instead we have distributed all the configuration options within
  224.       menus etc. wherever they are most appropriate.
  225.  
  226.       There is a question of philosophy here: it is easy to allow for great
  227.       user-configurability, but at the expense of the program becoming to
  228.       some extent unwieldy and over-complex to set up.  Alternatively we can
  229.       make certain decisions on behalf of the user.......which may not be to
  230.       everyone's taste.
  231.  
  232.       There always has to be a cut-off point, and we would like opinions
  233.       from those users who would like to see specific areas of the program
  234.       made more configurable.
  235.  
  236.  
  237. LOAD VOCABULARY HELP - Loads a new user-help file
  238.  
  239. SAVE ALL PATHS       - Saves all current path settings as the startup default
  240.  
  241. REDO SCREEN          - Rebuilds the interpreter screen display
  242.  
  243. EXECUTE DOS/AREXX COMMAND
  244.  
  245.                   - Automatically checks whether this is a DOS or AREXX
  246.                     command and executes the function as appropriate.
  247.  
  248. QUIT PROGRAM      -  Quits the program
  249.  
  250.  
  251. *******
  252. Editing
  253. *******
  254.  
  255. ENTER EDITOR 1    - Enters editor 1
  256.  
  257. ENTER EDITOR 2    - Enters editor 2
  258.  
  259. ENTER EDITOR 3    - Enters editor 3
  260.  
  261. ENTER OUT EDITOR  - Enters "OUT" editor
  262.  
  263. RETURN TO EDITOR  - Returns to last editing configuration
  264.  
  265. EDIT FILE         - If there is an unused editor, loads a file and enters
  266.                     the editor
  267.  
  268.  
  269. *********
  270. Compiling
  271. *********
  272.  
  273.  
  274. COMPILE ED1         - Compiles Editor1 according to current compile mode
  275.  
  276. COMPILE ED2         - Compiles Editor2 according to current compile mode
  277.  
  278. COMPILE ED2         - Compiles Editor3 according to current compile mode
  279.  
  280. COMPILE "OUT"       - Compiles "OUT" editor according to current compile
  281.                       mode
  282.  
  283. COMPILE LAST EDITOR - Compiles the last used editor according to current
  284.                       compile mode
  285.  
  286. COMPILE FILE        - Compiles a file according to current compile mode
  287.  
  288. PRELOAD FILE        - Loads a precompiled interpreter overlay
  289.  
  290. PRESAVE FILE        - Saves a precompiled interpreter overlay
  291.  
  292. COMPILE DICTIONARY  - Sets compile mode to normal dictionary compilation
  293.  
  294. COMPILE OVERLAY     - Sets compile mode to make external module overlays
  295.  
  296. COMPILE STANDALONE  - Sets compile mode to make true single file executables
  297.  
  298.  
  299. **********
  300. COPY/PASTE
  301. **********
  302.  
  303. COPY COMMAND LINES   - Copies current command lines to editor copy buffer
  304.  
  305. PASTE COMMAND LINES  - Pastes editor copy buffer into current command lines
  306.  
  307.  
  308. *******
  309. OPTIONS
  310. *******
  311.  
  312. SET COLOURS          - Opens the colour requester
  313.  
  314. LOAD COLOURS         - Loads a colour definition file
  315.  
  316. SAVE COLOURS         - Saves current colours as the startup default
  317.  
  318. SAVE COLOURS AS      - Saves current colours to a file
  319.  
  320.  
  321. OUTPUT -> "OUT"      - Allows you to set whether or not interpreter output
  322.                        goes to the "OUT" editor buffer
  323.  
  324. OUTPUT SEPARATORS    - Switches on and off output separator lines
  325.  
  326. SESSION MARKERS      - Switches on and off output session markers
  327.  
  328. RESET SESSION LOG    - Resets the output session number sequence to "1"
  329.  
  330. CLEAR "OUT" BUFFER   - Clears "Out" editor buffer
  331.  
  332. RESIZE "OUT" BUFFER  - Resets the size of the "Out" buffer
  333.  
  334. REBIND KEY           - Allows a shortcut key to be re-defined
  335.  
  336. UNBIND KEY           - Allows a shortcut key to be un-defined
  337.  
  338. LOAD KEYTABLE        - Allows you to load a shortcut key definition table
  339.  
  340. SAVE KEYTABLE        - Allows you to save the default shortcut key table
  341.  
  342. SAVE KEYTABLE AS     - Allows you to save a shortcut key definition table
  343.  
  344. ********
  345. INCLUDES
  346. ********
  347.  
  348. GET INCLUDE SYMBOL VALUE      - Searches resident include files for symbol
  349.  
  350. ADD SYMBOL TO USER INCLUDE    - Allows addition of a new symbol name and 
  351.                                 value
  352.  
  353. SAVE USER INCLUDE AS          - Saves the current resident user include file
  354.  
  355. LOAD USER INCLUDE FILE        - Loads include file as resident user include
  356.  
  357. LOAD AMIGA INCLUDE FILE       - Loads include file as resident Amiga include
  358.  
  359. SET USER INCLUDE DEFAULT      - Sets the default startup user include
  360.  
  361. SET AMIGA INCLUDE DEFAULT     - Sets the default startup Amiga include
  362.  
  363. USER INCLUDE SEARCH ON/OFF    - Enables/disables user include searches
  364.  
  365. AMIGA INCLUDE SEARCH ON/OFF   - Enables/disables user include searches
  366.  
  367. AUTOLOAD USER INCLUDE ON/OFF  - Enables/disables user include autoload
  368.  
  369. AUTOLOAD AMIGA INCLUDE ON/OFF - Enables/disables user include autoload
  370.  
  371. CONVERT "EQU" FILE TO INCLUDE - Allows conversion of ASCII file to include
  372.  
  373. DISPLAY CURRENT USER INCLUDE  - Displays all current user include symbols
  374.  
  375. CLEAR RESIDENT USER INCLUDE   - Clears the current resident user include
  376.  
  377. DELETE USER INCLUDE SYMBOL    - Deletes individual symbol from user include
  378.  
  379. *****************************************************************************
  380.